RCS Rich Card Carousel Message
Rich Card Carousel message can have up to 10 rich cards. Each card have their own image/video, title, description and up to 4 buttons. Along with this enterprise can add up to 10 buttons at the end of the carousel.
S.No. | Attribute | Required | Data Type | Details |
---|---|---|---|---|
3.1. | carousel_message | Yes | Object | Specifying that the message type is carousel message |
3.1.1. | cards | Yes | Array of Objects | Contains information of up to 10 cards. Each card has its own title, description, media, and buttons. |
3.1.1.1. | title | Yes | String | The title of the card. |
3.1.1.2. | description | Yes | String | The description of the card. |
3.1.1.3. | media_message | Yes | Object | Contains information related to the media to be sent in the message. |
3.1.1.3.1. | url | Yes | String | The URL of the image/video. |
3.1.1.4. | height | Yes | String | TALL, MEDIUM, SHORT. Image specifications are in the template specifications sheet attached above. |
3.1.1.5. | choices | No | Array of Objects | The number of choices is limited to 4. Select any combination of choices from below 4 objects. |
3.1.1.5.1. | call_message | No | Object | Button for triggering the call. |
3.1.1.5.1.1. | phone_number | Yes | String | Phone number in E.164 with leading +. E.g. +919876543210 |
3.1.1.5.1.2. | title | Yes | String | Title of the button |
3.1.1.5.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.1.5.1. | location_message | No | Object | Button containing geographic location |
3.1.1.5.1.1. | coordinates | Yes | Object | Containing latitude and longitude of the location |
3.1.1.5.1.1.1. | latitude | Yes | Number | Latitude of location |
3.1.1.5.1.1.2. | longitude | Yes | Number | Longitude of location |
3.1.1.5.1.2. | title | Yes | String | Title of the button |
3.1.1.5.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.1.5.1. | url_message | No | Object | Button for opening a URL |
3.1.1.5.1.1. | url | Yes | String | The URL to open |
3.1.1.5.1.2. | title | Yes | String | Title of the button |
3.1.1.5.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.1.5.1. | text_message | No | Object | Button for quick reply from the end user |
3.1.1.5.1.1. | text | Yes | String | This is the button title as well as the text to be sent from the end user. |
3.1.1.5.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.2. | choices | No | Array of Objects | These choices are outside the cards in the carousel. The number of choices is limited to 10. Select any combination of choices from below 4 objects. |
3.1.2.1. | call_message | No | Object | Button for triggering the call. |
3.1.2.1.1. | phone_number | Yes | String | Phone number in E.164 with leading +. E.g. +919876543210 |
3.1.2.1.2. | title | Yes | String | Title of the button |
3.1.2.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.2.1. | location_message | No | Object | Button containing geographic location |
3.1.2.1.1. | coordinates | Yes | Object | Containing latitude and longitude of the location |
3.1.2.1.1.1. | latitude | Yes | Number | Latitude of location |
3.1.2.1.1.2. | longitude | Yes | Number | Longitude of location |
3.1.2.1.2. | title | Yes | String | Title of the button |
3.1.2.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.2.1. | url_message | No | Object | Button for opening a URL |
3.1.2.1.1. | url | Yes | String | The URL to open |
3.1.2.1.2. | title | Yes | String | Title of the button |
3.1.2.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
3.1.2.1. | text_message | No | Object | Button for quick reply from the end user |
3.1.2.1.1. | text | Yes | String | This is the button title as well as the text to be sent from the end user |
3.1.2.2. | postback_data | Yes | String | Value is returned in the Click event of the accompanying button |
{
"app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA",
"recipient": {
"identified_by": {
"channel_identities": [
{
"channel": "RCS",
"identity": "917023002081"
}
]
}
},
"message": {
"carousel_message": {
"cards": [
{
"title": "Sign up for our weekly newsletter",
"description": "Our weekly newsletter is filled with deals and extra content!",
"media_message": {
"url": "https://sample-videos.com/img/Sample-jpg-image-100kb.jpg"
},
"height": "MEDIUM",
"choices": [
{
"url_message": {
"title": "Website",
"url": "https://www.xxx.com"
},
"postback_data": "Hello this is postback data."
}
]
},
{
"title": "Visit our website",
"description": "You can view your account and place ordersfrom our convenient dashboard."
,
"media_message": {
"url": "https://sample-videos.com/img/Sample-jpg-image-100kb.jpg"
},
"height": "MEDIUM",
"choices": [
{
"url_message": {
"title": "Website",
"url": "https://www.xxx.com"
},
"postback_data": "Hello this is postback data."
}
]
},
{
"title": "Call our customersupport line",
"description": "Our dedicated support staff can answer your questions and concerns.",
"media_message": {
"url": "https://sample-videos.com/img/Sample-jpg-image-100kb.jpg"
},
"height": "MEDIUM",
"choices": [
{
"url_message": {
"title": "Website",
"url": "https://www.xxx.com"
},
"postback_data": "Hello this is postback data."
}
]
}
],
"choices": [
{
"url_message": {
"title": "Click here",
"url": "https://www.xxx.com"
},
"postback_data": "Hello this is postback data."
},
{
"call_message": {
"title": "Call Us",
"phone_number": "+917023002081"
},
"postback_data": "call"
},
{
"location_message": {
"title": "Location",
"label": "Our Office",
"coordinates": {
"latitude": "28.5147",
"longitude": "77.3782"
}
},
"postback_data": "location"
},
{
"text_message": {
"text": "Confirm"
},
"postback_data": "reply"
}
]
}
}
}